Add Radarr sensor by tboyce021 · Pull Request #7318 · home-assistant/core

tboyce021 · 2017-04-26T16:42:07Z

Description:

Adds a sensor component for Radarr.

Pull request in home-assistant.github.io with documentation (if applicable): home-assistant/home-assistant.io#2567

Example entry for `configuration.yaml` (if applicable):

- platform: radarr
    api_key: !secret radarr_api_key
    host: 192.168.1.100
    monitored_conditions:
      - movies
      - upcoming
      - commands
      - diskspace
      - status
    days: 7

Checklist:

If user exposed functionality or configuration variables are added/changed:

Documentation added/updated in home-assistant.github.io

If the code communicates with devices, web services, or third-party tools:

Local tests with tox run successfully. Your PR cannot be merged unless tests pass
New dependencies have been added to the REQUIREMENTS variable (example).
New dependencies are only imported inside functions that use them (example).
New dependencies have been added to requirements_all.txt by running script/gen_requirements_all.py.
New files were added to .coveragerc.

If the code does not interact with devices:

Local tests with tox run successfully. Your PR cannot be merged unless tests pass
Tests have been added to verify that the new code works.

homeassistant · 2017-04-26T16:42:09Z

Hi @tboyce021,

It seems you haven't yet signed a CLA. Please do so here.

Once you do that we will be able to review and accept this pull request.

Thanks!

houndci-bot · 2017-04-26T16:42:14Z

+def to_unit(value, unit):
+    """Convert bytes to give unit."""
+    return value / 1024**BYTE_SIZES.index(unit)
+


blank line at end of file

houndci-bot · 2017-04-26T16:42:14Z

+def to_key(data):
+    return '{} ({})'.format(data['title'], data['year'])
+
+def to_unit(value, unit):


expected 2 blank lines, found 1

houndci-bot · 2017-04-26T16:42:15Z

+        date = data['inCinemas']
+    return date
+
+def to_key(data):


expected 2 blank lines, found 1

houndci-bot · 2017-04-26T16:42:15Z

+        datetime.fromtimestamp(time.time() + day*offset, tz=zone)
+    )
+
+def get_release_date(data):


expected 2 blank lines, found 1

houndci-bot · 2017-04-26T16:42:15Z

+    return datetime.date(
+        datetime.fromtimestamp(time.time() + day*offset, tz=zone)
+    )
+


blank line contains whitespace

houndci-bot · 2017-04-26T16:42:15Z

+                attributes[to_key(movie)] = movie['hasFile']
+        elif self.type == 'status':
+            attributes = self.data
+


blank line contains whitespace

houndci-bot · 2017-04-26T16:42:15Z

+                elif self.type == 'wanted':
+                    self.data = list(
+                        filter(
+                            lambda x: x['downloaded'] == False,


comparison to False should be 'if cond is False:' or 'if not cond:'

houndci-bot · 2017-04-26T16:42:15Z

+                if self.type == 'movies':
+                    self.data = list(
+                        filter(
+                            lambda x: x['downloaded'] == True,


comparison to True should be 'if cond is True:' or 'if cond:'

tboyce021 · 2017-04-26T16:51:50Z

NOTE: I have not tested this thoroughly yet (haven't tested upcoming at all). I just copied sonarr.py and made some adjustments so it would work with Radarr. Since not all of the data is the same, I just kind of picked something that looked useful.

tboyce021 · 2017-04-26T16:55:00Z

+                elif self.type == 'wanted':
+                    self.data = list(
+                        filter(
+                            lambda x: not x['downloaded'],


Wasn't really sure what to do here. Radarr doesn't have a "wanted" API, so I just filtered movies based on whether they were downloaded or not.

If Radarr doesn't support it, remove it.

fabaff · 2017-04-27T06:50:31Z

+import homeassistant.helpers.config_validation as cv
+from homeassistant.const import (CONF_API_KEY, CONF_HOST, CONF_PORT)
+from homeassistant.const import CONF_MONITORED_CONDITIONS
+from homeassistant.const import CONF_SSL


Merge all from homeassistant.const lines.

fabaff · 2017-04-27T06:50:36Z

+PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({
+    vol.Required(CONF_API_KEY): cv.string,
+    vol.Required(CONF_MONITORED_CONDITIONS, default=[]):
+        vol.All(cv.ensure_list, [vol.In(list(SENSOR_TYPES.keys()))]),


.keys() is the default. Needs to be removed for pylint 1.7.1.

fabaff · 2017-04-27T06:50:39Z

+        self.port = conf.get(CONF_PORT)
+        self.urlbase = conf.get(CONF_URLBASE)
+        if self.urlbase:
+            self.urlbase = "%s/" % self.urlbase.strip('/')


Please use string formatting.

Well, it doesn't add much value.

fabaff · 2017-04-27T06:58:00Z

+                elif self.type == 'wanted':
+                    self.data = list(
+                        filter(
+                            lambda x: not x['downloaded'],


If Radarr doesn't support it, remove it.

fabaff · 2017-04-27T07:04:00Z

+DEFAULT_URLBASE = ''
+DEFAULT_DAYS = '1'
+DEFAULT_UNIT = 'GB'
+


Add SCAN_INTERVAL. I think that's enough if this sensor is updated every 5 or 10 min per default.

fabaff · 2017-04-27T07:08:29Z

+                ENDPOINTS[self.type].format(
+                    self.ssl, self.host, self.port,
+                    self.urlbase, self.apikey, start, end),
+                timeout=5)


If would be easier to read if X-Api-Key is used.

Honestly, I have no idea how to do this.. I wrote very little of this myself. It's almost all copied from the existing Sonarr sensor.

See requests documentation or our own.

tboyce021 · 2017-05-02T00:24:48Z

+                )
+        elif self.type == 'movies':
+            for movie in self.data:
+                attributes[to_key(movie)] = movie['downloaded']


I also changed the attribute value to 'downloaded' instead of 'hasFile'. I honestly don't know which one is preferred. For me, they're always the same.

tboyce021 · 2017-05-02T00:33:44Z

I'll work on getting tests next but it'll take me a day or two to get set up for that.

homeassistant · 2017-05-02T05:23:48Z

Hello @tboyce021,

When attempting to inspect the commits of your pull request for CLA signature status among all authors we encountered commit(s) which were not linked to a GitHub account, thus not allowing us to determine their status(es).

The commits that are missing a linked GitHub account are the following:

53fad52f2d7410ed72e55cd31011a21bddf631ca - This commit has something that looks like an email address (trevor@da-lappy.lan). Maybe try linking that to GitHub?.

Unfortunately, we are unable to accept this pull request until this situation is corrected.

Here are your options:

If you had an email address set for the commit that simply wasn't linked to your GitHub account you can link that email now and it will retroactively apply to your commits. The simplest way to do this is to click the link to one of the above commits and look for a blue question mark in a blue circle in the top left. Hovering over that bubble will show you what email address you used. Clicking on that button will take you to your email address settings on GitHub. Just add the email address on that page and you're all set. GitHub has more information about this option in their help center.
If you didn't use an email address at all, it was an invalid email, or it's one you can't link to your GitHub, you will need to change the authorship information of the commit and your global Git settings so this doesn't happen again going forward. GitHub provides some great instructions on how to change your authorship information in their help center.
- If you only made a single commit you should be able to run
```
git commit --amend --author="Author Name <email@address.com>"
```
  (substituting Author Name and email@address.com for your actual information) to set the authorship information.
- If you made more than one commit and the commit with the missing authorship information is not the most recent one you have two options:
  1. You can re-create all commits missing authorship information. This is going to be the easiest solution for developers that aren't extremely confident in their Git and command line skills.
  2. You can use this script that GitHub provides to rewrite history. Please note: this should be used only if you are very confident in your abilities and understand its impacts.
- Whichever method you choose, I will come by to re-check the pull request once you push the fixes to this branch.

We apologize for this inconvenience, especially since it usually bites new contributors to Home Assistant. We hope you understand the need for us to protect ourselves and the great community we all have built legally. The best thing to come out of this is that you only need to fix this once and it benefits the entire Home Assistant and GitHub community.

Thanks, I look forward to checking this PR again soon! ❤️

houndci-bot · 2017-05-02T05:23:54Z

no newline at end of file

houndci-bot · 2017-05-02T05:23:54Z

line too long (89 > 79 characters)

houndci-bot · 2017-05-02T05:23:55Z

line too long (89 > 79 characters)

houndci-bot · 2017-05-02T05:23:55Z

line too long (89 > 79 characters)

houndci-bot · 2017-05-02T05:23:55Z

line too long (91 > 79 characters)

houndci-bot · 2017-05-02T05:23:55Z

line too long (340 > 79 characters)

houndci-bot · 2017-05-02T05:23:55Z

line too long (94 > 79 characters)

houndci-bot · 2017-05-02T05:23:55Z

line too long (94 > 79 characters)

houndci-bot · 2017-05-02T05:23:55Z

line too long (163 > 79 characters)

houndci-bot · 2017-05-02T05:23:55Z

local variable 'today' is assigned to but never used

houndci-bot · 2017-05-02T05:37:54Z

+            self.assertEqual('Radarr Upcoming', device.name)
+            self.assertEqual(
+                '2017-01-27T00:00:00Z',
+                device.device_state_attributes["Resident Evil: The Final Chapter (2017)"]


line too long (89 > 79 characters)

houndci-bot · 2017-05-02T05:37:55Z

+            self.assertEqual('Radarr Upcoming', device.name)
+            self.assertEqual(
+                '2017-01-27T00:00:00Z',
+                device.device_state_attributes["Resident Evil: The Final Chapter (2017)"]


line too long (89 > 79 characters)

houndci-bot · 2017-05-02T05:43:35Z

+                    {
+                        "coverType": "banner",
+                        "url": "/radarr/MediaCover/1/banner.jpg"
+                             + "?lastWrite=636200219340000000"


continuation line unaligned for hanging indent

houndci-bot · 2017-05-02T05:43:35Z

+                    {
+                        "coverType": "banner",
+                        "url": "/radarr/MediaCover/12/banner.jpg"
+                             + "?lastWrite=636208663600000000"


continuation line unaligned for hanging indent

houndci-bot · 2017-05-02T05:43:35Z

+"""The tests for the radarr platform."""
+import unittest
+import time
+from datetime import datetime


'datetime.datetime' imported but unused

houndci-bot · 2017-05-02T05:43:35Z

@@ -0,0 +1,451 @@
+"""The tests for the radarr platform."""
+import unittest
+import time


'time' imported but unused

houndci-bot · 2017-05-02T05:45:20Z

+                    {
+                        "coverType": "banner",
+                        "url": "/radarr/MediaCover/12/banner.jpg"
+                            + "?lastWrite=636208663600000000"


continuation line unaligned for hanging indent

tboyce021 · 2017-05-02T05:48:20Z

The tests were also mostly just copied from Sonarr, but with the data and stuff changed for Radarr. I'll work on getting the documentation up tomorrow.

Add radarr.py

9f12cf1

homeassistant added new-platform platform: sensor.radarr labels Apr 26, 2017

homeassistant added the cla-needed label Apr 26, 2017

houndci-bot reviewed Apr 26, 2017

View reviewed changes

homeassistant added cla-signed and removed cla-needed labels Apr 26, 2017

Update radarr.py

6ce25fd

tboyce021 commented Apr 26, 2017

View reviewed changes

fabaff requested changes Apr 27, 2017

View reviewed changes

Update radarr.py

4457242

tboyce021 commented May 2, 2017

View reviewed changes

homeassistant added the cla-error label May 2, 2017

balloobbot added platform and removed cla-error labels May 2, 2017

houndci-bot reviewed May 2, 2017

View reviewed changes

Add test_radarr.py

429accc

homeassistant added the cla-signed label May 2, 2017

houndci-bot reviewed May 2, 2017

View reviewed changes

Update test_radarr.py

e817f66

houndci-bot reviewed May 2, 2017

View reviewed changes

Update test_radarr.py

b96ccb5

houndci-bot reviewed May 2, 2017

View reviewed changes

Update radarr.py

9fb2f6b

tboyce021 mentioned this pull request May 5, 2017

Add Radarr sensor home-assistant/home-assistant.io#2567

Merged

tboyce021 and others added 2 commits May 4, 2017 19:23

Update .coveragerc

8cf4388

Fix hound.

9a7cd5f

balloob approved these changes Jun 5, 2017

View reviewed changes

balloob merged commit 2e27c0d into home-assistant:dev Jun 5, 2017

jesserockz mentioned this pull request Jun 5, 2017

Add juicenet platform #7668

Merged

6 tasks

fabaff mentioned this pull request Jun 5, 2017

Fix docstring #7907

Merged

1 task

tboyce021 deleted the tboyce021-radarr branch June 6, 2017 16:09

balloob mentioned this pull request Jun 16, 2017

0.47 #8055

Merged

home-assistant locked and limited conversation to collaborators Sep 4, 2017

ghost added integration: radarr and removed platform: sensor.radarr labels Mar 21, 2019

Uh oh!

Conversation

tboyce021 commented Apr 26, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description:

Example entry for configuration.yaml (if applicable):

Checklist:

Uh oh!

homeassistant commented Apr 26, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tboyce021 commented Apr 26, 2017

Uh oh!

tboyce021 Apr 26, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tboyce021 May 2, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tboyce021 commented May 2, 2017

Uh oh!

homeassistant commented May 2, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tboyce021 commented Apr 26, 2017 •

edited

Loading

Example entry for `configuration.yaml` (if applicable):

tboyce021 Apr 26, 2017 •

edited

Loading

tboyce021 May 2, 2017 •

edited

Loading